<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>StickySearch</title>
    <link href="../templates/style.css" rel="stylesheet" type="text/css" />
</head>

<body>
    <div id="nav"> 
        <h1 id="sitename"><a href="#">Sublime Text Wiki</a></h1> 
        <ul id="menu"> 
            <li class="active"><a href="../index.html" title="Home" accesskey="h"><span>H</span>ome</a></li> 
            <li><a href="../pages/This-site.html" title="About" accesskey="b"><span>A</span>bout</a></li>
            <li><a href="../pages/Documents.html" title="Documents" accesskey="c"><span>D</span>ocuments</a></li> 
        </ul> 
    </div>

    <div id="wrap">

        <div id="header">
        </div>

        <div id="topbar"> 
            <ul class="breadcrumb"> 
                <li>You Are Here &raquo;</li> 
                <li>sublimetextwiki.com &raquo; Packages &raquo; <a href="http://sublime-text-community-packages.googlecode.com/svn/pages/StickySearch.html">StickySearch</a></li> 
            </ul>
        </div>

        <div id="content">
            <div class="post">

                <div class="postheader">
                    <h2>The StickySearch Plugin</h2>
                </div>

                <h1>StickySearch</h1>
<p>allows you to highlight search items, regardless of your normal (ctrl+f) search items. this plug-in search items will be kept highlighted till you manually dismiss them.
</p>
<p>you can add markers, you can reset and clear markers. 
</p>

<h2>dependencies</h2>
<p>this plug-in is using an experimental sublime text API, exposed on 20091017 beta.
</p>
<p>to define what color you want to see for the marked text, you should edit your theme file, and add the following:
</p>
<pre><code>&lt;dict&gt;
    &lt;key&gt;name&lt;/key&gt;
    &lt;string&gt;Marker&lt;/string&gt;
    &lt;key&gt;scope&lt;/key&gt;
    &lt;string&gt;marker&lt;/string&gt;
    &lt;key&gt;settings&lt;/key&gt;
    &lt;dict&gt;
        &lt;key&gt;fontStyle&lt;/key&gt;
        &lt;string&gt;&lt;/string&gt;
        &lt;key&gt;foreground&lt;/key&gt;
        &lt;string&gt;#FFFF77&lt;/string&gt;
    &lt;/dict&gt;
&lt;/dict&gt;
</code></pre>
<h1>Usage</h1>
<p>This is the official binding:
</p>
<pre><code>&lt;bindings&gt;
    &lt;!-- sticky search --&gt;
    &lt;binding key="ctrl+shift+keypad_multiply" command="stickySearch set" /&gt;
    &lt;binding key="ctrl+shift+keypad_plus" command="stickySearch add" /&gt;
    &lt;binding key="ctrl+shift+keypad_minus" command="stickySearch clear" /&gt;
    &lt;binding key="ctrl+shift+keypad_divide" command="findNext" /&gt;
&lt;/bindings&gt;
</code></pre><ul>
 <li>
     'set' will mark the new item, after clearing the old markers
 </li>

 <li>
     'add' will mark the new item, leaving other marking as they were
 </li>

 <li>
     'clear' will clean all the markings
 </li>

 <li>
     'findNext' is equivalent to F3, it will ittirate over the last mark search results
 </li>
</ul>

                <div class="clear"> &nbsp; </div> 

                <h2>To Install This Plugin</h2>

                <ol>
                    <li>download the <a href="http://sublime-text-community-packages.googlecode.com/svn/packages/StickySearch.sublime-package ">StickySearch Plugin</a> to your local hard-drive.</li>
                    <li>double-click the package file</li>
                    <li>restart Sublime Text</li>
                </ol>

                <h2>For Developers</h2>

                <ul>
                    <li>This source code for this plugin is available at <a href="http://sublime-text-community-packages.googlecode.com/svn/trunk/StickySearch">google code.</a></li>
                    <li>Google provides <a href="http://code.google.com/p/sublime-text-community-packages/source/checkout">instructions for checking out the code</a></li>
                </ul>
            </div>
        </div>
        
        <div id="footerlinks"> 
            <ul id="footernav"> 
                <li><a href="../index.html" title="Home" accesskey="h"><span>H</span>ome</a></li> 
                <li><a href="../pages/This-site.html" title="About" accesskey="b"><span>A</span>bout</a></li> 
                <li><a href="../pages/Packages.html" title="Packages" accesskey="a"><span>P</span>ackages</a></li> 
            </ul> 
        </div>
        
        <div id="bottom">
            <p>Sublime Text Wiki &copy; All rights reserved | Valid XHTML</p>
            <!-- Do not alter or delete this from the template ================================================ -->  
            <p class="credit"><a href="http://www.ramblingsoul.com" title="Download Free CSS Website Templates">CSS Template</a> By RamblingSoul</p> 
            <!-- ============================================================================================== --> 
        </div>

    </div>

</body>

</html>
